home *** CD-ROM | disk | FTP | other *** search
/ The Arsenal Files 6 / The Arsenal Files 6 (Arsenal Computer).ISO / spitfire / logutl11.zip / LOGUTL.DOC < prev    next >
Text File  |  1996-02-26  |  7KB  |  148 lines
  1.  
  2.                                                               
  3.  
  4.       ------------------------------------------
  5.       ░▓█▓░  LOGUTL v1.1 (freeware)
  6.       ░▓█▓░  Copyright(c) 1996 by Eldon Martin
  7.       ------------------------------------------
  8.       
  9.         LOGUTL is  a  utility  designed  to  process  the CALLERS.LOG file
  10.       generated by Spitfire.  LOGUTL strips local  logins  and  outputs  a
  11.       statistical bulletin from information obtained from the callers log.
  12.       Unlike  some  other  CALLERS.LOG processors, LOGUTL does not offer a
  13.       "canned" selection of  bulletin  styles.   Instead, LOGUTL gives the
  14.       sysop complete control over the look and feel of  the  bulletins  it
  15.       generates.
  16.       
  17.         LOGUTL is freeware.  A small donation would  be  appreciated,  but
  18.       certainly  not  required.   If nothing else, just drop by my BBS and
  19.       say hi.  You may distribute this program  freely as long as it is in
  20.       its original form (all files are included and  unmodified).   LOGUTL
  21.       is  not  public  domain.  It is illegal to reverse-compile or modify
  22.       the program in any way.
  23.       
  24.       Here is a list of files that are part of this package:
  25.       
  26.       FILE_ID.DIZ    - The BBS description file
  27.       LOGUTL.EXE     - The main program executable file
  28.       LOGUTL.INI     - The configuration file
  29.       LOGUTL.DOC     - The program documentation  (this file)
  30.       DCF1.BBS       - Sample ASCII display configuration file
  31.       DCF1.CLR       - Sample ANSI display configuration file
  32.       DCF2.BBS       - Sample ASCII display configuration file
  33.       DCF2.CLR       - Sample ANSI display configuration file
  34.       
  35.         This program is provided on an "as is" basis.  I have tested it on
  36.       my computer, but cannot be held  responsible  for  any  problems  it
  37.       causes  you.  I tried to keep the code simple to avoid any bugs, but
  38.       if you happen to run across any, please let me know.
  39.                                                           
  40.       --------------------
  41.        How to use LOGUTL
  42.       --------------------
  43.       
  44.         LOGUTL  does not support any command line options.  The program is
  45.       started by running LOGUTL.EXE from the command line or a batch file.
  46.       CALLERS.LOG must be  found  in  the  current  directory in order for
  47.       LOGUTL  to  begin  operation.   LOGUTL  will   also   look   for   a
  48.       configuration  file  by the name of LOGUTL.INI.  If this file is not
  49.       found,  the  program  will  by   default  strip  local  logins  from
  50.       CALLERS.LOG and output the  resulting  log  to  mm-dd-yy.LOG,  where
  51.       mm-dd-yy is the current date.  In order to take advantage of most of
  52.       the  functions  of  LOGUTL,  you  must  edit LOGUTL.INI to suit your
  53.       needs, and  include  it  in  the  directory  in  which LOGUTL.EXE is
  54.       executed.  A sample LOGUTL.INI follows:
  55.       
  56.       ; Sample INI file for LOGUTL
  57.  
  58.  
  59.                                                               
  60.  
  61.  
  62.                                                               
  63.  
  64.       ; 
  65.       DisplayFile = BULLET7       ; Name of display file 
  66.       StripLocal = 1              ; Set to 1 to strip local logins
  67.       NewLogFile = NEWLOG.TXT     ; Output LOG file
  68.       DisplayConfigFile = CONFIG1 ; Name of display configuration file
  69.       DeleteOldLog = 0            ; Set to 1 to delete old CALLERS.LOG
  70.       ;
  71.       
  72.         For the most part, the above configuration  is  self  explanetory.
  73.       All  text  following  a  semicolon  on  the  same line is ignored by
  74.       LOGUTL.  Notice that  the  DisplayFile  and DisplayConfigFile do not
  75.       contain extensions.  LOGUTL automatically adds the appropiate  .BBS,
  76.       .CLR, or .RIP extensions as needed.
  77.       
  78.         The DisplayFile variable tells LOGUTL  the  name  of  the  display
  79.       file which is to display the statistics obtained in CALLERS.LOG.  If
  80.       the  variable  is  not  included in LOGUTL.INI or is left blank, the
  81.       program will simply refrain from writing a bulletin.
  82.       
  83.         The NewLogFile variable refers to the log file  LOGUTL  generates.
  84.       If  you  do  not  specify  an output file, the program will create a
  85.       mm-dd-yy.LOG as explained above.  If  you specify CALLERS.LOG as the
  86.       output file, the program will write to a temporary file by the  name
  87.       of _LOGFILE.TMP and then rename it as CALLERS.LOG when the operation
  88.       is complete.  Providing the StripLocal variable is set to 1, the new
  89.       log  file  will  not contain any local logins, and statistics gained
  90.       from local logins will not  be  included in the informative bulletin
  91.       the program generates.
  92.       
  93.         The display configuration file,  set  by the DisplayConfigFile, is
  94.       where the magic takes place.  If you leave the variable out or leave
  95.       it blank, LOGUTL will generate a "generic"  display  file.   If  you
  96.       specify a configuration file, LOGUTL loads it line by line, replaces
  97.       any  display  codes(see  below) it finds with the appropiate number,
  98.       and then outputs  a  bulletin,  which  is  named  by the DisplayFile
  99.       variable.  LOGUTL automatically searches for .BBS, .CLR, and .RIP of
  100.       the  display  configuration  file.   If  there  is   a   DisplayFile
  101.       specified,  but  not  a  DisplayConfigFile,  LOGUTL  will  output  a
  102.       bulletin of the default built-in style.
  103.       
  104.       Here is a list of display codes supported by LOGUTL:
  105.       
  106.       @A@ = Downloads made
  107.       @B@ = Uploads made
  108.       @C@ = Total calls to bbs
  109.       @D@ = New users added
  110.       @E@ = Number of times sysop was paged
  111.       @F@ = Comments left
  112.       @G@ = Messages written
  113.       @H@ = Bulletins read
  114.       @~~~@ = Space compensator
  115.       
  116.         What really  makes  full  configurability  possible  is  the space
  117.  
  118.                                                               
  119.  
  120.  
  121.                                                               
  122.  
  123.       compensator.  When LOGUTL encounters one of these,  it  replaces  it
  124.       with  a  number  of  spaces  equal  to  5 minus the number of digits
  125.       contained in the last statistic  displayed.   This allows one to use
  126.       replacement codes within a box, and then use a space compensator  to
  127.       make  sure the box is not thrown out of line.  The best way to learn
  128.       how to use these codes is by  experience.  Take a look at the sample
  129.       display configuration files included in this  package  to  help  you
  130.       understand how display codes are used.
  131.       
  132.       -----------------------
  133.         The Data Sector BBS 
  134.       -----------------------
  135.       
  136.         This  program  was provided to you by the sysop of The Data Sector
  137.       BBS.  Call today to make sure  you have the latest version of LOGUTL
  138.       and to have a look at other great  utilities  for  Spitfire  sysops.
  139.       The  number is (717) 485 - 5914 and supports 300 to 14400 baud.  You
  140.       can also reach the author of  this program by the snail mail address
  141.       below.  Thank you for using LOGUTL.
  142.       
  143.         Eldon Martin                             BBS: (717) 485-5914
  144.         HCR 75 Box 99                            SFNET Node A0717008
  145.         McConnellsburg, PA 17233
  146.                                                               
  147.  
  148.